/*
  Copyright 2011 The Rhizosphere Authors. All Rights Reserved.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
*/

package com.rhizospherejs.gwt.client;

import com.google.gwt.core.client.JavaScriptObject;

/**
 * An opaque pointer holding a reference to a Rhizosphere model. Every model
 * added to the visualization via {@link Rhizosphere#addModel(Object, 
 * RhizosphereCallback1)} is assigned a reference. References can be later used
 * to issue programmatic commands affecting one or more specific models.
 *
 * @author battlehorse@google.com (Riccardo Govoni)
 */
public class RhizosphereModelRef extends JavaScriptObject {
  protected RhizosphereModelRef() {}

  /**
   * Casts an object generated by a
   * {@link com.rhizospherejs.gwt.client.bridge.ModelBridge} into an opaque
   * reference.
   */
  public static final native RhizosphereModelRef asModelRef(JavaScriptObject jso) /*-{
    return jso;
  }-*/;
  
}
